/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Initial Developer of the Original Code is
*   Nick Kreeger
* Portions created by the Initial Developer are Copyright (C) 2006-2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*   Nick Kreeger <nick.kreeger@park.edu>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */

#import <Cocoa/Cocoa.h>
#import "nsISupportsArray.h"
#import "nsIMsgAccount.h"

@class MessageAccount;
@class SmtpServerItem;
class nsISmtpServer;

extern NSString* const kAccountRegistryChanged;

/**
 * Provide a easy to access Obj-C wrapper class to the
 * gecko message account manager.
 *
 * Note that this all depends on nsMsgAccountManager being compiled
 * into the lib, if not we have to write our own.
 */
// this class really doesn't manage, should be a utility.
@interface MessageAccountManager : NSObject  
{
}

+(id)sharedInstance;

-(BOOL)getAccounts:(nsISupportsArray**)inSupportsArray;

-(BOOL)accountsExist;
-(BOOL)createAccount:(MessageAccount*)aMessageAccount;
-(BOOL)removeMsgAccount:(nsIMsgAccount*)aMessageAccount;
-(BOOL)setDefaultMsgAccount:(nsIMsgAccount*)aMessageAccount;
-(void)saveAccounts;

/**
 * Find out if the user needs to authenticate.
 * @return If the user needs to authenticate.
 */
-(BOOL)userNeedsToAuth;

-(NSArray*)smtpServerList;
-(SmtpServerItem*)defaultSmtpServerItem;
-(SmtpServerItem*)defaultSmtpServerItemForIdentity:(nsIMsgIdentity*)aMsgIdentity;

@end

#pragma mark -

/**
 * Define a simple class to wrap a SMTP server and store
 * temporary instance variables that can be saved as needed.
 */
@interface SmtpServerItem : NSObject
{
  nsISmtpServer* mSmtpServerRef;  // weak
  NSString*      mDescription;
  NSString*      mServerName;
  NSString*      mUsername;
  unsigned int   mPortNum;
  unsigned int   mSocketType;  // would be nice to have a enum here.
  BOOL           mUseAuthentication;
}

-(id)initWithSmtpServer:(nsISmtpServer*)aSmtpServer;
-(nsISmtpServer*)smtpServer;
-(NSString*)displayName;

-(void)setDescription:(NSString*)aDescription;
-(void)setServerName:(NSString*)aServerName;
-(void)setUsername:(NSString*)aUsername;
-(void)setPortNum:(unsigned int)aPortNum;
-(void)setSocketType:(unsigned int)aSocketType;
-(void)setUseAuthentication:(BOOL)inShouldUseAuth;
-(NSString*)description;
-(NSString*)serverName;
-(NSString*)username;
-(unsigned int)portNum;
-(unsigned int)socketType;
-(BOOL)useAuthentication;

/**
 * This method saves the servers settings with the values from
 * that have been set in |serDescription:|, |setServerName:|, 
 * |setPortNum:|, |setSocketType:|, and |setUseAuthentication:|.
 */
-(void)saveSettings;

@end
